/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2008-2011, Salzburg Research. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * - Neither the name of the KiWi Project nor the names of its contributors
 *   may be used to endorse or promote products derived from this software
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * Contributor(s):
 *  sstroka
 *
 * File Info:
 *   User: sstroka
 *   Date: 2011/02/18
 *   Time: 10:09
 *
 * Project: KiWi2, kiwi-core module
 */

package kiwi.core.api.security;

import kiwi.core.model.security.RefreshToken;
import kiwi.core.model.user.KiWiUser;

/**
 * This service checks oauth access tokens against expiration date and existing user
 * User: Stephanie Stroka
 * Date: 18.02.2011
 * Time: 10:09:18
 */
public interface TokenManagerService {

    /**
     *  maps access token and refresh token to user
     * @param user
     * @param token
     * @param refreshToken
     * @param expiration
     * @return true if the token is new
     */
    public boolean setToken(KiWiUser user, String token, String refreshToken, int expiration);

    /**
     * getRefreshToken() returns a refreshTokenEntity if the refreshToken could be found
     * @param refreshToken
     * @return refreshTokenEntity
     */
    public RefreshToken getRefreshToken(String refreshToken);

    /**
     * removes an accessToken, e.g. if the token gets invalid
     * @param token
     * @return true if token could be found and removed, false if token could not be found
     */
    public boolean removeAccessToken(String accessToken);

    /**
     * removes a refreshToken, e.g. if the user logs out
     * @param token
     * @return true if token could be found and removed, false if token could not be found
     */
    public boolean removeRefreshToken(String refreshToken);

    /**
     * validates if the accessToken is valid and not expired
     * @param token
     * @return the KiWiUser, if the accessToken is valid and not expired
     */
    public KiWiUser validateAccessToken(String accessToken);
}
